OPC Studio User's Guide and Reference
ToEnumerable<T>(ITreeTraversable<T>,TreeTraversalType) Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Graphs.Extensions Namespace > ITreeTraversableExtension Class > ToEnumerable Method : ToEnumerable<T>(ITreeTraversable<T>,TreeTraversalType) Method
The type of objects to traverse.
The tree traversable to be converted to an enumerable.

The value of this parameter cannot be null (Nothing in Visual Basic).

Type of algorithm used to traverse nodes of a tree.
Converts the tree traversable to an "enumerable" of tree nodes, using the specified tree traversal type.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ToEnumerable(Of T)( _
   ByVal source As ITreeTraversable(Of T), _
   ByVal treeTraversalType As TreeTraversalType _
) As IEnumerable(Of T)
'Usage
 
Dim source As ITreeTraversable(Of T)
Dim treeTraversalType As TreeTraversalType
Dim value As IEnumerable(Of T)
 
value = ITreeTraversableExtension.ToEnumerable(Of T)(source, treeTraversalType)
[Extension()]
[NotNull()]
public static IEnumerable<T> ToEnumerable<T>( 
   ITreeTraversable<T> source,
   TreeTraversalType treeTraversalType
)
[Extension()]
[NotNull()]
public:
static IEnumerable<T^>^ ToEnumerablegeneric<typename T>
( 
   ITreeTraversable<T^>^ source,
   TreeTraversalType treeTraversalType
) 

Parameters

source
The tree traversable to be converted to an enumerable.

The value of this parameter cannot be null (Nothing in Visual Basic).

treeTraversalType
Type of algorithm used to traverse nodes of a tree.

Type Parameters

T
The type of objects to traverse.

Return Value

Returns a sequence of tree nodes created by visiting the nodes of source using the traversal algorithm specified by OpcLabs.BaseLib.Graphs.TreeTraversalType.

This method never returns null (Nothing in Visual Basic).

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also